<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketserver;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.IOException;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.net.BindException;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.net.Socket;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.net.SocketException;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.Collection;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Collections;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.HashMap;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.LinkedList;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Map;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    import org.apache.log4j.Logger;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    /**<a name="line.15"></a>
<FONT color="green">016</FONT>     * A low level message server that mediates messages from and to clients and the server in the form of 'datagrams' (custom serialized<a name="line.16"></a>
<FONT color="green">017</FONT>     * messages identified by a unique signature). See {@link ClientMessageToServer} for further details on these messages.<a name="line.17"></a>
<FONT color="green">018</FONT>     * &lt;p&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * This class manages some server basics such as the server {@link Socket}, {@link ServerType} to create the server endpoint with, the port<a name="line.19"></a>
<FONT color="green">020</FONT>     * on which this server listens and the server state (stopped, stopping, running) as well as a maintaining a flag that indicated the use of<a name="line.20"></a>
<FONT color="green">021</FONT>     * ping / pong mode. This class also contains the lists of message types mapped to the unique identifiers known to both the clients and<a name="line.21"></a>
<FONT color="green">022</FONT>     * server.<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * Furthermore, this class receives new client connections and assigns {@link ClientHandler} instances (see {@link #clientHandlers}). The<a name="line.24"></a>
<FONT color="green">025</FONT>     * client handlers offer executable messages from clients back for the server to queue them and execute them sequentially (see<a name="line.25"></a>
<FONT color="green">026</FONT>     * {@link #clientMessages}).<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * This server embodies the client listening function regardless of the type of server (UDP / TCP) in a uniform way. The differences between<a name="line.28"></a>
<FONT color="green">029</FONT>     * UDP and TCP are managed by the {@link #serverType}. Everything that this server is used for can be done with either TCP or UDP without<a name="line.29"></a>
<FONT color="green">030</FONT>     * the user having to change anything. Just provide the right {@link ServerType} and the server changes without breaking API.<a name="line.30"></a>
<FONT color="green">031</FONT>     * <a name="line.31"></a>
<FONT color="green">032</FONT>     * @author Benny Bottema<a name="line.32"></a>
<FONT color="green">033</FONT>     * @since 1.0<a name="line.33"></a>
<FONT color="green">034</FONT>     */<a name="line.34"></a>
<FONT color="green">035</FONT>    public class SwiftSocketServer {<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>            private static final Logger LOGGER = Logger.getLogger(SwiftSocketServer.class);<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>            /**<a name="line.39"></a>
<FONT color="green">040</FONT>             * The internal message id, {@value #MESSAGE_ID_PINGPONG}, used to communicate ping pong messages.<a name="line.40"></a>
<FONT color="green">041</FONT>             */<a name="line.41"></a>
<FONT color="green">042</FONT>            private static final int MESSAGE_ID_PINGPONG = 999;<a name="line.42"></a>
<FONT color="green">043</FONT>            /**<a name="line.43"></a>
<FONT color="green">044</FONT>             * The internal message id, {@value #MESSAGE_ID_BYEBYE}, used to recognize an incoming Bye Bye notification.<a name="line.44"></a>
<FONT color="green">045</FONT>             */<a name="line.45"></a>
<FONT color="green">046</FONT>            private static final int MESSAGE_ID_BYEBYE = 998;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>            private final int port;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>            /**<a name="line.50"></a>
<FONT color="green">051</FONT>             * The {@link ServerType} used to create the TCP/UDP {@link ServerEndpoint} with.<a name="line.51"></a>
<FONT color="green">052</FONT>             */<a name="line.52"></a>
<FONT color="green">053</FONT>            private final ServerType serverType;<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>            /**<a name="line.55"></a>
<FONT color="green">056</FONT>             * the server endpoint takes care of sending message to clients and receiving incoming client sockets. Created when starting the server<a name="line.56"></a>
<FONT color="green">057</FONT>             * as a TCP or UDP endpoint.<a name="line.57"></a>
<FONT color="green">058</FONT>             * <a name="line.58"></a>
<FONT color="green">059</FONT>             * @see ServerEndpoint<a name="line.59"></a>
<FONT color="green">060</FONT>             */<a name="line.60"></a>
<FONT color="green">061</FONT>            private ServerEndpoint serverEndpoint;<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>            /**<a name="line.63"></a>
<FONT color="green">064</FONT>             * Used to identify a {@link ClientMessageToServer} type that can handle a binary packet.<a name="line.64"></a>
<FONT color="green">065</FONT>             */<a name="line.65"></a>
<FONT color="green">066</FONT>            private final Map&lt;Integer, Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt;&gt; clientMessageToServerTypeList;<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>            /**<a name="line.68"></a>
<FONT color="green">069</FONT>             * Contains context objects mapped directly against a executable client message type. Usage of this list is optional.<a name="line.69"></a>
<FONT color="green">070</FONT>             * &lt;p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>             * This mechanism automates executing messages using a pre-registered context object. Client messages that are registered in this list<a name="line.71"></a>
<FONT color="green">072</FONT>             * will not be queued in the {@link #clientMessages} queue for manual processing.<a name="line.72"></a>
<FONT color="green">073</FONT>             */<a name="line.73"></a>
<FONT color="green">074</FONT>            private final Map&lt;Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt;, Object&gt; executionContexts;<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>            /**<a name="line.76"></a>
<FONT color="green">077</FONT>             * Used to prepend the right binary packet code for a given {@link ServerMessageToClient} type.<a name="line.77"></a>
<FONT color="green">078</FONT>             */<a name="line.78"></a>
<FONT color="green">079</FONT>            private final Map&lt;Class&lt;? extends ServerMessageToClient&gt;, Integer&gt; serverMessageToClientIdList;<a name="line.79"></a>
<FONT color="green">080</FONT>    <a name="line.80"></a>
<FONT color="green">081</FONT>            /**<a name="line.81"></a>
<FONT color="green">082</FONT>             * A queue that contains unprocessed messages from any client.<a name="line.82"></a>
<FONT color="green">083</FONT>             */<a name="line.83"></a>
<FONT color="green">084</FONT>            private final LinkedList&lt;ClientMessageToServer&lt;?&gt;&gt; clientMessages;<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            /**<a name="line.86"></a>
<FONT color="green">087</FONT>             * A list of simultaneous client connection handlers, for receiving {@link ClientMessageToServer} messages and sending<a name="line.87"></a>
<FONT color="green">088</FONT>             * {@link ServerMessageToClient} messages.<a name="line.88"></a>
<FONT color="green">089</FONT>             */<a name="line.89"></a>
<FONT color="green">090</FONT>            private final Map&lt;ClientContext, ClientHandler&gt; clientHandlers;<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>            /**<a name="line.92"></a>
<FONT color="green">093</FONT>             * Indicates whether stop() has been called and the server socket has been closed.<a name="line.93"></a>
<FONT color="green">094</FONT>             */<a name="line.94"></a>
<FONT color="green">095</FONT>            private boolean stopping;<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>            /**<a name="line.97"></a>
<FONT color="green">098</FONT>             * Default turned off in the constructor.<a name="line.98"></a>
<FONT color="green">099</FONT>             */<a name="line.99"></a>
<FONT color="green">100</FONT>            private boolean pingPongMode;<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>            /**<a name="line.102"></a>
<FONT color="green">103</FONT>             * Interval in milliseconds for ping messages to the client. Default set to 2500ms in the constructor.<a name="line.103"></a>
<FONT color="green">104</FONT>             */<a name="line.104"></a>
<FONT color="green">105</FONT>            private int pingPongIntervalMs;<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>            /**<a name="line.107"></a>
<FONT color="green">108</FONT>             * Timeout in milliseconds for a pong message to the client. Default set to 5000ms in the constructor.<a name="line.108"></a>
<FONT color="green">109</FONT>             */<a name="line.109"></a>
<FONT color="green">110</FONT>            private int pingPongTimeoutMs;<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>            /**<a name="line.112"></a>
<FONT color="green">113</FONT>             * Default constructor, calls {@link #SwiftSocketServer(int, ServerType)} with TCP {@link ServerType}.<a name="line.113"></a>
<FONT color="green">114</FONT>             * <a name="line.114"></a>
<FONT color="green">115</FONT>             * @param port The port on which to start listening.<a name="line.115"></a>
<FONT color="green">116</FONT>             */<a name="line.116"></a>
<FONT color="green">117</FONT>            public SwiftSocketServer(final int port) {<a name="line.117"></a>
<FONT color="green">118</FONT>                    this(port, ServerType.TCP);<a name="line.118"></a>
<FONT color="green">119</FONT>            }<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>            /**<a name="line.121"></a>
<FONT color="green">122</FONT>             * Creates a swift socket server and registers a couple of basic message types (message invalid, 'Ping Pong' and 'Bye Bye'). Also sets<a name="line.122"></a>
<FONT color="green">123</FONT>             * default Ping Pong interval and timeout. The Ping Pong mode is turned off by default.<a name="line.123"></a>
<FONT color="green">124</FONT>             * &lt;ul&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>             * &lt;li&gt;Message invalid: sent to the client when a message code was not recognized&lt;/li&gt;<a name="line.125"></a>
<FONT color="green">126</FONT>             * &lt;li&gt;Ping message: sent when {@link #setPingPongMode(boolean, int, int)} feature is turned on&lt;/li&gt;<a name="line.126"></a>
<FONT color="green">127</FONT>             * &lt;li&gt;ByeBye message: sent as an ACK message when a client is gracefully disconnecting by sending a Bye Bye message&lt;/li&gt;<a name="line.127"></a>
<FONT color="green">128</FONT>             * &lt;/ul&gt;<a name="line.128"></a>
<FONT color="green">129</FONT>             * <a name="line.129"></a>
<FONT color="green">130</FONT>             * @param port The port on which to start listening.<a name="line.130"></a>
<FONT color="green">131</FONT>             * @param serverType The {@link ServerType} strategy used to communicate.<a name="line.131"></a>
<FONT color="green">132</FONT>             */<a name="line.132"></a>
<FONT color="green">133</FONT>            public SwiftSocketServer(final int port, final ServerType serverType) {<a name="line.133"></a>
<FONT color="green">134</FONT>                    this.port = port;<a name="line.134"></a>
<FONT color="green">135</FONT>                    this.serverType = serverType;<a name="line.135"></a>
<FONT color="green">136</FONT>                    pingPongMode = false;<a name="line.136"></a>
<FONT color="green">137</FONT>                    pingPongIntervalMs = 2500;<a name="line.137"></a>
<FONT color="green">138</FONT>                    pingPongTimeoutMs = 5000;<a name="line.138"></a>
<FONT color="green">139</FONT>                    clientMessageToServerTypeList = new HashMap&lt;Integer, Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt;&gt;();<a name="line.139"></a>
<FONT color="green">140</FONT>                    serverMessageToClientIdList = new HashMap&lt;Class&lt;? extends ServerMessageToClient&gt;, Integer&gt;();<a name="line.140"></a>
<FONT color="green">141</FONT>                    clientMessages = new LinkedList&lt;ClientMessageToServer&lt;?&gt;&gt;();<a name="line.141"></a>
<FONT color="green">142</FONT>                    clientHandlers = Collections.synchronizedMap(new HashMap&lt;ClientContext, ClientHandler&gt;());<a name="line.142"></a>
<FONT color="green">143</FONT>                    executionContexts = new HashMap&lt;Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt;, Object&gt;();<a name="line.143"></a>
<FONT color="green">144</FONT>    <a name="line.144"></a>
<FONT color="green">145</FONT>                    registerClientMessageToServerType(MESSAGE_ID_PINGPONG, ClientMessageToServerPingPong.class);<a name="line.145"></a>
<FONT color="green">146</FONT>                    registerClientMessageToServerType(MESSAGE_ID_BYEBYE, ClientMessageToServerByeBye.class);<a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>                    registerServerMessageToClientId(MESSAGE_ID_PINGPONG, ServerMessageToClientPingPong.class);<a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>            /**<a name="line.151"></a>
<FONT color="green">152</FONT>             * Sets PingPong mode, use to poll clients for time-outs. Clients will need to support this as well. When changed, will only apply the<a name="line.152"></a>
<FONT color="green">153</FONT>             * new setting to &lt;strong&gt;new&lt;/strong&gt; clients.<a name="line.153"></a>
<FONT color="green">154</FONT>             * <a name="line.154"></a>
<FONT color="green">155</FONT>             * @param pingPongMode Flag indicating use of ping pong mode yes/no.<a name="line.155"></a>
<FONT color="green">156</FONT>             */<a name="line.156"></a>
<FONT color="green">157</FONT>            public void setPingPongMode(final boolean pingPongMode) {<a name="line.157"></a>
<FONT color="green">158</FONT>                    this.pingPongMode = pingPongMode;<a name="line.158"></a>
<FONT color="green">159</FONT>            }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>            /**<a name="line.161"></a>
<FONT color="green">162</FONT>             * Sets PingPong mode, use to poll clients for time-outs. Clients will need to support this as well. When changed, will only apply the<a name="line.162"></a>
<FONT color="green">163</FONT>             * new setting to &lt;strong&gt;new&lt;/strong&gt; clients.<a name="line.163"></a>
<FONT color="green">164</FONT>             * <a name="line.164"></a>
<FONT color="green">165</FONT>             * @param pingPongMode Flag indicating use of ping pong mode yes/no.<a name="line.165"></a>
<FONT color="green">166</FONT>             * @param pingPongIntervalMs Interval in milliseconds for ping messages to the client.<a name="line.166"></a>
<FONT color="green">167</FONT>             * @param pingPongTimeoutMs Timeout in milliseconds for a pong message to the client.<a name="line.167"></a>
<FONT color="green">168</FONT>             */<a name="line.168"></a>
<FONT color="green">169</FONT>            public void setPingPongMode(final boolean pingPongMode, final int pingPongIntervalMs, final int pingPongTimeoutMs) {<a name="line.169"></a>
<FONT color="green">170</FONT>                    this.pingPongMode = pingPongMode;<a name="line.170"></a>
<FONT color="green">171</FONT>                    this.pingPongIntervalMs = pingPongIntervalMs;<a name="line.171"></a>
<FONT color="green">172</FONT>                    this.pingPongTimeoutMs = pingPongTimeoutMs;<a name="line.172"></a>
<FONT color="green">173</FONT>            }<a name="line.173"></a>
<FONT color="green">174</FONT>    <a name="line.174"></a>
<FONT color="green">175</FONT>            /**<a name="line.175"></a>
<FONT color="green">176</FONT>             * Registers a client-to-server message on the given unique identifier. Both the client and server must use the same identifier to be<a name="line.176"></a>
<FONT color="green">177</FONT>             * able to decode the message on the server.<a name="line.177"></a>
<FONT color="green">178</FONT>             * <a name="line.178"></a>
<FONT color="green">179</FONT>             * @param messageId The unique identifier for this message type.<a name="line.179"></a>
<FONT color="green">180</FONT>             * @param messageType A {@link ClientMessageToServer} sub type.<a name="line.180"></a>
<FONT color="green">181</FONT>             */<a name="line.181"></a>
<FONT color="green">182</FONT>            public void registerClientMessageToServerType(final int messageId, final Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt; messageType) {<a name="line.182"></a>
<FONT color="green">183</FONT>                    clientMessageToServerTypeList.put(messageId, messageType);<a name="line.183"></a>
<FONT color="green">184</FONT>            }<a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>            /**<a name="line.186"></a>
<FONT color="green">187</FONT>             * Registers a server-to-client message on the given unique identifier. Both the client and server must use the same identifier to be<a name="line.187"></a>
<FONT color="green">188</FONT>             * able to decode the message on the client.<a name="line.188"></a>
<FONT color="green">189</FONT>             * <a name="line.189"></a>
<FONT color="green">190</FONT>             * @param messageId The unique identifier for this message type.<a name="line.190"></a>
<FONT color="green">191</FONT>             * @param messageType A {@link ServerMessageToClient} sub type.<a name="line.191"></a>
<FONT color="green">192</FONT>             */<a name="line.192"></a>
<FONT color="green">193</FONT>            public void registerServerMessageToClientId(final int messageId, final Class&lt;? extends ServerMessageToClient&gt; messageType) {<a name="line.193"></a>
<FONT color="green">194</FONT>                    serverMessageToClientIdList.put(messageType, messageId);<a name="line.194"></a>
<FONT color="green">195</FONT>            }<a name="line.195"></a>
<FONT color="green">196</FONT>    <a name="line.196"></a>
<FONT color="green">197</FONT>            /**<a name="line.197"></a>
<FONT color="green">198</FONT>             * Registers a default execution context for a client-to-server message type. Incoming messages of the given type are not queued in<a name="line.198"></a>
<FONT color="green">199</FONT>             * {@link #clientMessages}, but executed directly using the registered execution context. This way the user doesn't have to manually<a name="line.199"></a>
<FONT color="green">200</FONT>             * process these executable client messages.<a name="line.200"></a>
<FONT color="green">201</FONT>             * <a name="line.201"></a>
<FONT color="green">202</FONT>             * @param messageType The type of message that will be matched and executed using the given context object.<a name="line.202"></a>
<FONT color="green">203</FONT>             * @param executionContext The execution context object used to execute executable client messages against.<a name="line.203"></a>
<FONT color="green">204</FONT>             */<a name="line.204"></a>
<FONT color="green">205</FONT>            public void registerExecutionContext(final Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt; messageType, final Object executionContext) {<a name="line.205"></a>
<FONT color="green">206</FONT>                    executionContexts.put(messageType, executionContext);<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>            /**<a name="line.209"></a>
<FONT color="green">210</FONT>             * Thread safe method that starts the client thread, listening for new messages and sending messages.<a name="line.210"></a>
<FONT color="green">211</FONT>             * <a name="line.211"></a>
<FONT color="green">212</FONT>             * @see InvisibleServerRunner<a name="line.212"></a>
<FONT color="green">213</FONT>             */<a name="line.213"></a>
<FONT color="green">214</FONT>            public void start() {<a name="line.214"></a>
<FONT color="green">215</FONT>                    LOGGER.info("booting Swift message server. Hold on...");<a name="line.215"></a>
<FONT color="green">216</FONT>                    if (serverType == ServerType.UDP &amp;&amp; !pingPongMode) {<a name="line.216"></a>
<FONT color="green">217</FONT>                            LOGGER.warn("WARNING: running UDP server without ping pong mode: if a client connection drops, we won't know!");<a name="line.217"></a>
<FONT color="green">218</FONT>                    }<a name="line.218"></a>
<FONT color="green">219</FONT>                    stopping = false;<a name="line.219"></a>
<FONT color="green">220</FONT>                    new Thread(new InvisibleServerRunner()).start();<a name="line.220"></a>
<FONT color="green">221</FONT>            }<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>            /**<a name="line.223"></a>
<FONT color="green">224</FONT>             * @return Whether there are unprocessed client messages waiting in queue to be executed.<a name="line.224"></a>
<FONT color="green">225</FONT>             */<a name="line.225"></a>
<FONT color="green">226</FONT>            public boolean hasClientMessages() {<a name="line.226"></a>
<FONT color="green">227</FONT>                    return clientMessages.size() &gt; 0;<a name="line.227"></a>
<FONT color="green">228</FONT>            }<a name="line.228"></a>
<FONT color="green">229</FONT>    <a name="line.229"></a>
<FONT color="green">230</FONT>            /**<a name="line.230"></a>
<FONT color="green">231</FONT>             * @return The next queues unprocessed client messages to be executed (see {@link LinkedList#poll()}).<a name="line.231"></a>
<FONT color="green">232</FONT>             */<a name="line.232"></a>
<FONT color="green">233</FONT>            public ClientMessageToServer&lt;?&gt; getNextClientMessage() {<a name="line.233"></a>
<FONT color="green">234</FONT>                    return clientMessages.poll();<a name="line.234"></a>
<FONT color="green">235</FONT>            }<a name="line.235"></a>
<FONT color="green">236</FONT>    <a name="line.236"></a>
<FONT color="green">237</FONT>            /**<a name="line.237"></a>
<FONT color="green">238</FONT>             * Removes a {@link ClientContext} and associated {@link ClientHandler} from the list of known clients.<a name="line.238"></a>
<FONT color="green">239</FONT>             * <a name="line.239"></a>
<FONT color="green">240</FONT>             * @param client The client we need to purge along with its connection handler.<a name="line.240"></a>
<FONT color="green">241</FONT>             */<a name="line.241"></a>
<FONT color="green">242</FONT>            protected void disposeOfClient(final ClientContext client) {<a name="line.242"></a>
<FONT color="green">243</FONT>                    synchronized (this) {<a name="line.243"></a>
<FONT color="green">244</FONT>                            synchronized (client) {<a name="line.244"></a>
<FONT color="green">245</FONT>                                    synchronized (clientHandlers) {<a name="line.245"></a>
<FONT color="green">246</FONT>                                            client.setClientSaidByeBye(true);<a name="line.246"></a>
<FONT color="green">247</FONT>                                            clientHandlers.remove(client);<a name="line.247"></a>
<FONT color="green">248</FONT>                                            try {<a name="line.248"></a>
<FONT color="green">249</FONT>                                                    client.getClientEndpoint().close();<a name="line.249"></a>
<FONT color="green">250</FONT>                                            } catch (final IOException e) {<a name="line.250"></a>
<FONT color="green">251</FONT>                                                    LOGGER.error("error disposing client: socket IOException: " + e.getMessage());<a name="line.251"></a>
<FONT color="green">252</FONT>                                            }<a name="line.252"></a>
<FONT color="green">253</FONT>                                    }<a name="line.253"></a>
<FONT color="green">254</FONT>                            }<a name="line.254"></a>
<FONT color="green">255</FONT>                    }<a name="line.255"></a>
<FONT color="green">256</FONT>            }<a name="line.256"></a>
<FONT color="green">257</FONT>    <a name="line.257"></a>
<FONT color="green">258</FONT>            /**<a name="line.258"></a>
<FONT color="green">259</FONT>             * Thread that assigns {@link #serverEndpoint} with a new server endpoint and starts handling new messages.<a name="line.259"></a>
<FONT color="green">260</FONT>             * &lt;p&gt;<a name="line.260"></a>
<FONT color="green">261</FONT>             * Since {@link Runnable} is a public interface and we don't want the &lt;code&gt;run&lt;/code&gt; method exposed directly, we'll use an<a name="line.261"></a>
<FONT color="green">262</FONT>             * intermediate invisible class (outside the parent class at least) that implements it.<a name="line.262"></a>
<FONT color="green">263</FONT>             * <a name="line.263"></a>
<FONT color="green">264</FONT>             * @author Benny Bottema<a name="line.264"></a>
<FONT color="green">265</FONT>             * @since 1.0<a name="line.265"></a>
<FONT color="green">266</FONT>             */<a name="line.266"></a>
<FONT color="green">267</FONT>            private class InvisibleServerRunner implements Runnable {<a name="line.267"></a>
<FONT color="green">268</FONT>                    @Override<a name="line.268"></a>
<FONT color="green">269</FONT>                    public void run() {<a name="line.269"></a>
<FONT color="green">270</FONT>                            try {<a name="line.270"></a>
<FONT color="green">271</FONT>                                    serverEndpoint = serverType.createServerEndpoint(port);<a name="line.271"></a>
<FONT color="green">272</FONT>                                    final String msg = "server booting done. Waiting for clients @ port %s (%s)...";<a name="line.272"></a>
<FONT color="green">273</FONT>                                    LOGGER.info(String.format(msg, port, serverType.name()));<a name="line.273"></a>
<FONT color="green">274</FONT>                                    handleMessages(serverEndpoint);<a name="line.274"></a>
<FONT color="green">275</FONT>                            } catch (final BindException e) {<a name="line.275"></a>
<FONT color="green">276</FONT>                                    LOGGER.debug(e);<a name="line.276"></a>
<FONT color="green">277</FONT>                                    LOGGER.info("server already running! Quiting...");<a name="line.277"></a>
<FONT color="green">278</FONT>                                    stop();<a name="line.278"></a>
<FONT color="green">279</FONT>                            } catch (final IOException e) {<a name="line.279"></a>
<FONT color="green">280</FONT>                                    e.printStackTrace();<a name="line.280"></a>
<FONT color="green">281</FONT>                            }<a name="line.281"></a>
<FONT color="green">282</FONT>                    }<a name="line.282"></a>
<FONT color="green">283</FONT>            }<a name="line.283"></a>
<FONT color="green">284</FONT>    <a name="line.284"></a>
<FONT color="green">285</FONT>            /**<a name="line.285"></a>
<FONT color="green">286</FONT>             * Listens for new clients on the server endpoint. Creates a new {@link ClientHandler} for each new {@link ClientEndpoint}.<a name="line.286"></a>
<FONT color="green">287</FONT>             * <a name="line.287"></a>
<FONT color="green">288</FONT>             * @param serverEndpoint The server endpoint on which we expect client messages.<a name="line.288"></a>
<FONT color="green">289</FONT>             * @throws IOException Thrown by {@link ServerEndpoint#getClientEndpoint()}.<a name="line.289"></a>
<FONT color="green">290</FONT>             */<a name="line.290"></a>
<FONT color="green">291</FONT>            private void handleMessages(final ServerEndpoint serverEndpoint)<a name="line.291"></a>
<FONT color="green">292</FONT>                            throws IOException {<a name="line.292"></a>
<FONT color="green">293</FONT>                    while (!isStopping()) {<a name="line.293"></a>
<FONT color="green">294</FONT>                            try {<a name="line.294"></a>
<FONT color="green">295</FONT>                                    final ClientEndpoint clientEndpoint = serverEndpoint.getClientEndpoint();<a name="line.295"></a>
<FONT color="green">296</FONT>                                    if (!isStopping()) {<a name="line.296"></a>
<FONT color="green">297</FONT>                                            final ClientContext clientContext = new ClientContext(clientEndpoint);<a name="line.297"></a>
<FONT color="green">298</FONT>                                            final ClientHandler clientHandler = new ClientHandler(this, clientContext, pingPongMode, pingPongIntervalMs,<a name="line.298"></a>
<FONT color="green">299</FONT>                                                            pingPongTimeoutMs);<a name="line.299"></a>
<FONT color="green">300</FONT>                                            clientHandlers.put(clientContext, clientHandler);<a name="line.300"></a>
<FONT color="green">301</FONT>                                            new Thread(clientHandler).start();<a name="line.301"></a>
<FONT color="green">302</FONT>                                    }<a name="line.302"></a>
<FONT color="green">303</FONT>                            } catch (final SocketException e) {<a name="line.303"></a>
<FONT color="green">304</FONT>                                    LOGGER.error("server socket crashed, shutting server down...", e);<a name="line.304"></a>
<FONT color="green">305</FONT>                                    stop();<a name="line.305"></a>
<FONT color="green">306</FONT>                            }<a name="line.306"></a>
<FONT color="green">307</FONT>                    }<a name="line.307"></a>
<FONT color="green">308</FONT>            }<a name="line.308"></a>
<FONT color="green">309</FONT>    <a name="line.309"></a>
<FONT color="green">310</FONT>            /**<a name="line.310"></a>
<FONT color="green">311</FONT>             * Finds the right client handler based on the message's client context and sends the message to it.<a name="line.311"></a>
<FONT color="green">312</FONT>             * <a name="line.312"></a>
<FONT color="green">313</FONT>             * @param message The message to send to the client associated with it.<a name="line.313"></a>
<FONT color="green">314</FONT>             * @see ClientHandler#sendMessage(ServerMessageToClient)<a name="line.314"></a>
<FONT color="green">315</FONT>             */<a name="line.315"></a>
<FONT color="green">316</FONT>            public void sendMessage(final ServerMessageToClient message) {<a name="line.316"></a>
<FONT color="green">317</FONT>                    clientHandlers.get(message.getClientContext()).sendMessage(message);<a name="line.317"></a>
<FONT color="green">318</FONT>            }<a name="line.318"></a>
<FONT color="green">319</FONT>    <a name="line.319"></a>
<FONT color="green">320</FONT>            /**<a name="line.320"></a>
<FONT color="green">321</FONT>             * @param message The message to send to all clients (ignoring clientContext on the message).<a name="line.321"></a>
<FONT color="green">322</FONT>             * @see SwiftSocketServer#broadcastMessage(ServerMessageToClient)<a name="line.322"></a>
<FONT color="green">323</FONT>             */<a name="line.323"></a>
<FONT color="green">324</FONT>            public void broadcastMessage(final ServerMessageToClient message) {<a name="line.324"></a>
<FONT color="green">325</FONT>                    synchronized (clientHandlers) {<a name="line.325"></a>
<FONT color="green">326</FONT>                            for (final ClientContext clientcontext : getAllClientContexts()) {<a name="line.326"></a>
<FONT color="green">327</FONT>                                    if (!clientcontext.isClientSaidByeBye()) {<a name="line.327"></a>
<FONT color="green">328</FONT>                                            clientHandlers.get(clientcontext).sendMessage(message);<a name="line.328"></a>
<FONT color="green">329</FONT>                                    }<a name="line.329"></a>
<FONT color="green">330</FONT>                            }<a name="line.330"></a>
<FONT color="green">331</FONT>                    }<a name="line.331"></a>
<FONT color="green">332</FONT>            }<a name="line.332"></a>
<FONT color="green">333</FONT>    <a name="line.333"></a>
<FONT color="green">334</FONT>            /**<a name="line.334"></a>
<FONT color="green">335</FONT>             * @return {@link #stopping}<a name="line.335"></a>
<FONT color="green">336</FONT>             */<a name="line.336"></a>
<FONT color="green">337</FONT>            private boolean isStopping() {<a name="line.337"></a>
<FONT color="green">338</FONT>                    return stopping;<a name="line.338"></a>
<FONT color="green">339</FONT>            }<a name="line.339"></a>
<FONT color="green">340</FONT>    <a name="line.340"></a>
<FONT color="green">341</FONT>            /**<a name="line.341"></a>
<FONT color="green">342</FONT>             * Adds a message to the queue for later processing, unless a known context object has been registered for this object in<a name="line.342"></a>
<FONT color="green">343</FONT>             * {@link #executionContexts}.<a name="line.343"></a>
<FONT color="green">344</FONT>             * <a name="line.344"></a>
<FONT color="green">345</FONT>             * @param message The message to be executed now if registered with {@link #executionContexts}, or later manually.<a name="line.345"></a>
<FONT color="green">346</FONT>             */<a name="line.346"></a>
<FONT color="green">347</FONT>            @SuppressWarnings("unchecked")<a name="line.347"></a>
<FONT color="green">348</FONT>            protected void addClientMessage(final ClientMessageToServer&lt;?&gt; message) {<a name="line.348"></a>
<FONT color="green">349</FONT>                    if (executionContexts.containsKey(message.getClass())) {<a name="line.349"></a>
<FONT color="green">350</FONT>                            final Object contextObject = executionContexts.get(message.getClass());<a name="line.350"></a>
<FONT color="green">351</FONT>                            ((ClientMessageToServer&lt;? super Object&gt;) message).execute(contextObject);<a name="line.351"></a>
<FONT color="green">352</FONT>                    } else {<a name="line.352"></a>
<FONT color="green">353</FONT>                            clientMessages.offer(message);<a name="line.353"></a>
<FONT color="green">354</FONT>                    }<a name="line.354"></a>
<FONT color="green">355</FONT>            }<a name="line.355"></a>
<FONT color="green">356</FONT>    <a name="line.356"></a>
<FONT color="green">357</FONT>            /**<a name="line.357"></a>
<FONT color="green">358</FONT>             * @param messageId The message id for which to find the registered message type.<a name="line.358"></a>
<FONT color="green">359</FONT>             * @return The client-to-server message type associated with the given message id, or {@link ClientMessageToServerInvalid} if not found.<a name="line.359"></a>
<FONT color="green">360</FONT>             */<a name="line.360"></a>
<FONT color="green">361</FONT>            protected Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt; getClientMessageToServerType(final int messageId) {<a name="line.361"></a>
<FONT color="green">362</FONT>                    final Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt; messageType = clientMessageToServerTypeList.get(messageId);<a name="line.362"></a>
<FONT color="green">363</FONT>                    return (messageType != null) ? messageType : ClientMessageToServerInvalid.class;<a name="line.363"></a>
<FONT color="green">364</FONT>            }<a name="line.364"></a>
<FONT color="green">365</FONT>    <a name="line.365"></a>
<FONT color="green">366</FONT>            /**<a name="line.366"></a>
<FONT color="green">367</FONT>             * @param serverMessageToClientType The message type to identify.<a name="line.367"></a>
<FONT color="green">368</FONT>             * @return The unique identifier registered for the given message type.<a name="line.368"></a>
<FONT color="green">369</FONT>             */<a name="line.369"></a>
<FONT color="green">370</FONT>            public int getServerMessageId(final Class&lt;? extends ServerMessageToClient&gt; serverMessageToClientType) {<a name="line.370"></a>
<FONT color="green">371</FONT>                    return serverMessageToClientIdList.get(serverMessageToClientType);<a name="line.371"></a>
<FONT color="green">372</FONT>            }<a name="line.372"></a>
<FONT color="green">373</FONT>    <a name="line.373"></a>
<FONT color="green">374</FONT>            /**<a name="line.374"></a>
<FONT color="green">375</FONT>             * @return All client contexts currently known. These clients are not necessarily active.<a name="line.375"></a>
<FONT color="green">376</FONT>             */<a name="line.376"></a>
<FONT color="green">377</FONT>            public Collection&lt;ClientContext&gt; getAllClientContexts() {<a name="line.377"></a>
<FONT color="green">378</FONT>                    return clientHandlers.keySet();<a name="line.378"></a>
<FONT color="green">379</FONT>            }<a name="line.379"></a>
<FONT color="green">380</FONT>    <a name="line.380"></a>
<FONT color="green">381</FONT>            /**<a name="line.381"></a>
<FONT color="green">382</FONT>             * Thread safe method to make the server initialize stopping procedure. This means setting a flag and letting client handlers manage<a name="line.382"></a>
<FONT color="green">383</FONT>             * disconnecting the clients, while closing the server socket simultaneously.<a name="line.383"></a>
<FONT color="green">384</FONT>             */<a name="line.384"></a>
<FONT color="green">385</FONT>            public void stop() {<a name="line.385"></a>
<FONT color="green">386</FONT>                    stopping = true;<a name="line.386"></a>
<FONT color="green">387</FONT>                    shutdown();<a name="line.387"></a>
<FONT color="green">388</FONT>            }<a name="line.388"></a>
<FONT color="green">389</FONT>    <a name="line.389"></a>
<FONT color="green">390</FONT>            private void shutdown() {<a name="line.390"></a>
<FONT color="green">391</FONT>                    if (serverEndpoint != null &amp;&amp; !serverEndpoint.isClosed()) {<a name="line.391"></a>
<FONT color="green">392</FONT>                            try {<a name="line.392"></a>
<FONT color="green">393</FONT>                                    serverEndpoint.close();<a name="line.393"></a>
<FONT color="green">394</FONT>                            } catch (final IOException e) {<a name="line.394"></a>
<FONT color="green">395</FONT>                                    LOGGER.error(e.getMessage(), e);<a name="line.395"></a>
<FONT color="green">396</FONT>                            }<a name="line.396"></a>
<FONT color="green">397</FONT>                    }<a name="line.397"></a>
<FONT color="green">398</FONT>            }<a name="line.398"></a>
<FONT color="green">399</FONT>    <a name="line.399"></a>
<FONT color="green">400</FONT>            /**<a name="line.400"></a>
<FONT color="green">401</FONT>             * @return Whether the server is not stopping.<a name="line.401"></a>
<FONT color="green">402</FONT>             */<a name="line.402"></a>
<FONT color="green">403</FONT>            public boolean isRunning() {<a name="line.403"></a>
<FONT color="green">404</FONT>                    return !isStopping();<a name="line.404"></a>
<FONT color="green">405</FONT>            }<a name="line.405"></a>
<FONT color="green">406</FONT>    }<a name="line.406"></a>




























































</PRE>
</BODY>
</HTML>
